onLogin()

Availability:

SmartFoxServer Lite / Basic / Pro

Usage:

smartFox.onLogin(response <propList>)

Description:

The event is fired in response to a login() request.

Parameters:

The response propertylist contains the following properties:

success   True if the login was successfull, False if login failed. The reason for failure is explained in the error parameter
name   Your current nickname
error   This parameter is passed only if login fails. It contains a server error message.

NOTE: The server sends the nickname back to the client because not all nicknames are possibile. For example those containing bad words maybe filtered.

Returns:

nothing

Example: 

on onLogin me, response
	if (response.success) then put("Logged in as " & response.name)
	else put("Could not login: " & response.error)
end

See also: